VIVE 3DSP Native C Library  ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
Related Functions
vive_3dsp_room Struct Reference

The vive_3dsp_room structure represents the 3D room model, including the reflection and reverberation effects. More...

#include <vive_3dsp_api/room.h>

Related Functions

(Note that these are not member functions.)

vive_3dsp_room * vive_3dsp_room_create_object (vive_3dsp_context *api)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_destroy_object (vive_3dsp_context *api, vive_3dsp_room *room)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_set_size (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Vector3 size)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_set_position (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Vector3 pos)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_set_rotation (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Quaternion rot)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_set_material (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PLANE room_plane, VIVE_3DSP_REVERB_MATERIAL room_material)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_set_reverb_preset (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_REVERB_PRESET room_reverb_preset)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_set_reflection (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PLANE room_plane, float rate)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_set_gain (vive_3dsp_context *api, vive_3dsp_room *room, float gain)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_enable (vive_3dsp_context *api, vive_3dsp_room *room, bool enable)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_setDryLevel (vive_3dsp_context *api, vive_3dsp_room *room, float level_dB)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_setReflectionLevel (vive_3dsp_context *api, vive_3dsp_room *room, float level_dB)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_setReverbLevel (vive_3dsp_context *api, vive_3dsp_room *room, float level_dB)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_set_property (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PROPERTY prop)
 
float * vive_3dsp_room_get_bgaudio (vive_3dsp_context *api, int id)
 
VIVE_3DSP_API_STATUS vive_3dsp_room_free_bgaudio (vive_3dsp_context *api, float *pBgaudio)
 

Detailed Description

The vive_3dsp_room structure represents the 3D room model, including the reflection and reverberation effects.

Examples:
Example.cpp.

Friends And Related Function Documentation

◆ vive_3dsp_room_create_object()

vive_3dsp_room * vive_3dsp_room_create_object ( vive_3dsp_context *  api)
related

Create a room object in the specific audio engine.

Parameters
apiThe audio engine object.
Returns
A room object.

◆ vive_3dsp_room_destroy_object()

VIVE_3DSP_API_STATUS vive_3dsp_room_destroy_object ( vive_3dsp_context *  api,
vive_3dsp_room *  room 
)
related

Destroy a room object in the specific audio engine.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_enable()

VIVE_3DSP_API_STATUS vive_3dsp_room_enable ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
bool  enable 
)
related

Enable or disable room effect of all audio source objects.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
enableSet true to enable the effect. Otherwise, set false.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_free_bgaudio()

VIVE_3DSP_API_STATUS vive_3dsp_room_free_bgaudio ( vive_3dsp_context *  api,
float *  pBgaudio 
)
related

Set the level of the background audio signal.

Parameters
apiThe audio engine object.
pBgaudioBackground audio data.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_get_bgaudio()

float * vive_3dsp_room_get_bgaudio ( vive_3dsp_context *  api,
int  id 
)
related

Set the level of the background audio signal.

Parameters
apiThe audio engine object.
idFile ID. It refers to HTC_Vive3DSP_SDK::RoomBackgroundAudioType.
Returns
1 second background audio data in 48000 Hz sample rate, 16-bit resolution.

◆ vive_3dsp_room_set_gain()

VIVE_3DSP_API_STATUS vive_3dsp_room_set_gain ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
float  gain 
)
related

Set output gain of the room effect.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
gainOutput gain. It should be nonnegative and in linear scale.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_set_material()

VIVE_3DSP_API_STATUS vive_3dsp_room_set_material ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
VIVE_3DSP_ROOM_PLANE  room_plane,
VIVE_3DSP_REVERB_MATERIAL  room_material 
)
related

Set the materials of all the surfaces around the room.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
room_planeSpecify the surface you want to set. It can be ROOM_FLOOR, ROOM_CEILING, and ROOM_WALL.
room_materialSpecify the material of room_plane. It will give different amounts of the reflection of the surface. Refer to HTC_Vive3DSP_SDK::VIVE_3DSP_REVERB_MATERIAL.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_set_position()

VIVE_3DSP_API_STATUS vive_3dsp_room_set_position ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
VIVE_3DSP_Vector3  pos 
)
related

Set the room position. It is expressed as the centroid of the room.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
posThe position of the room along with x, y, and z axis.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_set_property()

VIVE_3DSP_API_STATUS vive_3dsp_room_set_property ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
VIVE_3DSP_ROOM_PROPERTY  prop 
)
related

Set room properties.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
propThe room property structure.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_set_reflection()

VIVE_3DSP_API_STATUS vive_3dsp_room_set_reflection ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
VIVE_3DSP_ROOM_PLANE  room_plane,
float  rate 
)
related

Set the reflection rates of all the surfaces around the room.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
room_planeSpecify the surface you want to set. It can be ROOM_FLOOR, ROOM_CEILING, and ROOM_WALL.
rateThe reflection rate. The value 0 represents perfect absortion and 1 is perfect reflection.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_set_reverb_preset()

VIVE_3DSP_API_STATUS vive_3dsp_room_set_reverb_preset ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
VIVE_3DSP_ROOM_REVERB_PRESET  room_reverb_preset 
)
related

Set the preset of the room reverb.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
room_reverb_presetSpecify the room reverb preset you want to set. It will give different preset of the room reverb. Refer to HTC_Vive3DSP_SDK::VIVE_3DSP_ROOM_REVERB_PRESET.
\return     Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_set_rotation()

VIVE_3DSP_API_STATUS vive_3dsp_room_set_rotation ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
VIVE_3DSP_Quaternion  rot 
)
related

Set the room rotation.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
rotThe rotation of the room in quaternion angle.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_set_size()

VIVE_3DSP_API_STATUS vive_3dsp_room_set_size ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
VIVE_3DSP_Vector3  size 
)
related

Set the room size. So far the room is expressed as a cube.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
sizeThe size of the room along with x, y, and z axis.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_setDryLevel()

VIVE_3DSP_API_STATUS vive_3dsp_room_setDryLevel ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
float  level_dB 
)
related

Set the level of the dry signal.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
level_dBThe level in dB scale.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_setReflectionLevel()

VIVE_3DSP_API_STATUS vive_3dsp_room_setReflectionLevel ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
float  level_dB 
)
related

Set the level of the early reflection signal.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
level_dBThe level in dB scale.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_room_setReverbLevel()

VIVE_3DSP_API_STATUS vive_3dsp_room_setReverbLevel ( vive_3dsp_context *  api,
vive_3dsp_room *  room,
float  level_dB 
)
related

Set the level of the revereration signal.

Parameters
apiThe audio engine object.
roomThe room object created by vive_3dsp_room_create_object.
level_dBThe level in dB scale.
Returns
Status code indicating whether or not the operation succeeded.

The documentation for this struct was generated from the following file: